/**
 * KopsoxFramework
 * Copyright (C) 2010 Free Software Foundation, Inc. <http://fsf.org/>
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.kopsox.util.persistence;

import java.util.List;

import org.kopsox.comm.message.ErrorMessage;
import org.kopsox.util.persistence.impl.KopsoxPersistenceException;

/**
 * This interface provides methods to persist or load data.<br>
 * 
 * @author Konrad Renner - 17.11.2010
 *
 */
public interface Persistable {

	/**
	 * Registers an PersistenceDelegate
	 * 
	 * @param delegate
	 * @return boolean - returns true if the delegate is registered
	 */
	public boolean registerPersistenceDelegate(PersistenceDelegate delegate);
	
	/**
	 * Unregisters an PersistenceDelegate
	 * 
	 * @return boolean - returns true if the delegate is unregistered
	 */
	public boolean unregisterPersistenceDelegate();
	
	/**
	 * Persists the data with the help of the PersistenceDelegate
	 * 
	 * @return List<ErrorMessage>
	 * @throws KopsoxPersistenceException 
	 */
	public List<ErrorMessage> persist()throws KopsoxPersistenceException;
	
	/**
	 * Loads the data with the help of the PersistenceDelegate
	 * 
	 * @return List<ErrorMessage>
	 * @throws KopsoxPersistenceException 
	 */
	public List<ErrorMessage> load()throws KopsoxPersistenceException;
}
